Skip to main content

使用基本认证添加身份验证

使用基本认证的 API 将通过用户名和密码对用户进行身份验证。在您的 Zapier 集成中使用基本认证时，Zapier 会在每次轮询 API 端点以获取新数据或向 API 端点发布新数据时，都会在 API 请求包中包含用户名和密码凭据。

Authentication

Zapier 中用户的基本认证屏幕示例

如果您的 API 需要用户名和密码或其他基本字段、不需要特殊配置，并且特别使用 “HTTP 基本认证” 时，请使用基本认证。如果您需要进一步自定义登录流程或从用户处请求额外数据，API 密钥认证 可能更合适。

1. 构建输入表单​

  • 在 Zapier 视觉构建器的身份验证选项卡中打开，并选择基本认证。

Authentication

  • 基本认证的预构建输入表单已经包含用户名和密码字段。

  • 如果您的 API 文档要求添加额外字段，请选择 '添加字段' 并填写该字段的详细信息。同时，首先按照用户预期的顺序添加最常用的字段，因为添加后无法重新排序。

Authentication

  • 添加所需的 'API 键'，这是您的 API 用于引用此字段的名称。

  • 根据需要填写可选字段，尤其是“标签”：

– 标签：此字段的人类友好名称，将显示在身份验证表单中。

– 是否必填？（复选框）：如果此字段对于成功身份验证是必需的，请选中。

– 类型：所有输入字段默认使用 string 文本字段；如果您希望在用户输入时隐藏数据，请选择 password。

– 帮助文本：提供详细信息以帮助用户进行身份验证，尤其是如果他们不确定在哪里找到所需数据。请使用 Markdown 格式化文本，并根据需要添加超链接。

– 输入格式：（可选）帮助用户了解需要输入的确切数据。例如，对于子域（如 子域验证），请使用格式如 'https://sub.yourdomain.com/'，以帮助用户理解。

– 默认值：为该字段提供一个备用值。对于可选字段，默认值会在初始连接创建时设置，并在 Zap 运行时用于替换缺失或空值。对于必填字段，此值仅在连接创建时使用，而在 Zap 运行时如果值为缺失或空值，Zapier 会引发错误。

Authentication

  • 标记为密码的输入字段，以及所有包含敏感私有数据的身份验证字段（如基本认证中的用户名和密码），都会在运行时自动屏蔽。这些值会存储在 Auth 包中并用于 API 调用，但在 Zapier 的日志中会被替换为类似 :censored:6:82a3be9927: 的屏蔽值。因此，无法在 Zapier 的日志中查看确切的令牌或密钥。要验证身份验证返回的令牌是否在后续 API 调用中使用，可以比较屏蔽值的字符，例如 :censored:6:82a3be9927: 在后续调用中会以相同的结尾如 9927。

  • 计算字段不适用于基本认证，仅用于 OAuth v2 和会话认证。

  • 每个输入字段都会在您的身份验证设置中列出其标签、键、类型和必填状态。点击字段进行编辑，或点击齿轮图标并选择“删除”来移除字段。

Authentication

  • 一旦您为身份验证表单添加了所有输入字段，请选择“继续”。

2. 添加测试 API 请求​

  • 添加一个不需要配置的 API 调用，通常是 /user 或 /me 调用。添加 API 调用的 URL，并设置调用类型，通常为 GET。这样可以测试用户输入的凭据是否能启用对您的应用的成功 API 调用。

  • 用户名和密码输入字段会自动包含在 URL 参数和 HTTP 标头中。点击“显示选项”以在不需要的地方移除这些细节。通常不推荐在 URL 参数中传递任何敏感信息（如密码），最好通过标头或正文传递。

Authentication

  • 要自定义测试 API 请求，请选择“切换到代码模式”并编写自定义 JavaScript 代码来处理您的测试 API 调用和响应解析。首次点击切换时，Zapier 会将您的 API 调用转换为代码。但是，如果您切换回表单模式，Zapier 不会将代码更改转换回表单模式，也不会将后续表单更改添加到您的代码中。

Authentication

3. 配置连接标签​

查看 连接标签文档 以可选方式区分用户连接的应用账户。

4. 测试您的身份验证​

连接一个有效的用户账户以 测试身份验证。

需要帮助？告诉我们您的问题，我们会将您连接到合适的资源或联系支持。